api_request Element

Description

starts a connection request.

Namespace

(none)

Diagram

Overview

api_request

starts a connection request.

Sequence

action xs:string

One of nine action types. This lets us know the type of connection you wish to make and what you need the API to do for you. In the case of sending a job, the action type is "upload".

username xs:string

The username of this user as stored on the PRODOCOM system. You will need to get this information from PRODOCOM before you attempt any form of API connection. Typically the username is PRODOCOM website login.

password xs:string

The password of this user as stored on the PRODOCOM system. You will need to get this information from PRODOCOM before you attempt any form of API connection.

reference xs:string

Used for client reporting purposes.

attachment

The information within an attachment sequence contains the information for the document to be uploaded.

Sequence

name xs:string

The name of the file to be uploaded.

subdir xs:string

The name of a subdirectory for the file to be stored in. If this is not required, do not use this field.

filedata xs:string

The file data to be uploaded in base64 format.

duration xs:string

The number of days that the file is to be stored in the host location for.

Source

<xs:element name="api_request" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:complexType>
    <xs:sequence>
      <xs:element type="xs:string" name="action" />
      <xs:element type="xs:string" name="username" />
      <xs:element type="xs:string" name="password" />
      <xs:element type="xs:string" name="reference" />
      <xs:element name="attachment">
        <xs:complexType>
          <xs:sequence>
            <xs:element type="xs:string" name="name" />
            <xs:element type="xs:string" name="subdir" />
            <xs:element type="xs:string" name="filedata" />
            <xs:element type="xs:string" name="duration" />
          </xs:sequence>
        </xs:complexType>
      </xs:element>
    </xs:sequence>
  </xs:complexType>
</xs:element>